SGI Freeware 1999 August/SGI Freeware 1999 August.iso/dist/fw_qt.idb/usr/freeware/catman/p_man/cat3/qboxlayout.Z/qboxlayout

Text File | 1998-10-28 | 16.5 KB | 331 lines

     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))



     NNNNAAAAMMMMEEEE
      QBoxLayout - Lines up    child widgets horizontally or
      vertically

     SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
      #include <qlayout.h>

      Inherits QLayout.

      Inherited by QHBoxLayout and QVBoxLayout.

    PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrrssss
      QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt (((( QQQQWWWWiiiiddddggggeeeetttt **** _p_a_r_e_n_t,,,, DDDDiiiirrrreeeeccccttttiiiioooonnnn,,,, iiiinnnntttt    _b_o_r_d_e_r====0000,,,, iiiinnnntttt
          _a_u_t_o_B_o_r_d_e_r
      QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt (((( DDDDiiiirrrreeeeccccttttiiiioooonnnn,,,, iiiinnnntttt _a_u_t_o_B_o_r_d_e_r ==== ----1111,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr ****
          _n_a_m_e====0000 ))))
      ~~~~QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt ()
      vvvvooooiiiidddd aaaaddddddddSSSSppppaaaacccciiiinnnngggg (((( iiiinnnntttt    ssssiiiizzzzeeee ))))
      vvvvooooiiiidddd aaaaddddddddSSSSttttrrrreeeettttcccchhhh (((( iiiinnnntttt    _s_t_r_e_t_c_h    ==== 0000 ))))
      vvvvooooiiiidddd aaaaddddddddWWWWiiiiddddggggeeeetttt (((( QQQQWWWWiiiiddddggggeeeetttt ****,,,, iiiinnnntttt _s_t_r_e_t_c_h ==== 0000,,,, iiiinnnntttt _a_l_i_g_n_m_e_n_t ====
          AAAAlllliiiiggggnnnnCCCCeeeennnntttteeeerrrr ))))
      vvvvooooiiiidddd aaaaddddddddLLLLaaaayyyyoooouuuutttt (((( QQQQLLLLaaaayyyyoooouuuutttt **** _l_a_y_o_u_t,,,, iiiinnnntttt _s_t_r_e_t_c_h ==== 0000 ))))
      DDDDiiiirrrreeeeccccttttiiiioooonnnn ddddiiiirrrreeeeccccttttiiiioooonnnn (((()))) ccccoooonnnnsssstttt
      vvvvooooiiiidddd aaaaddddddddSSSSttttrrrruuuutttt    (((( iiiinnnntttt ))))

    PPPPrrrrooootttteeeecccctttteeeedddd MMMMeeeemmmmbbbbeeeerrrrssss
      vvvviiiirrrrttttuuuuaaaallll QQQQCCCChhhhaaaaiiiinnnn**** mmmmaaaaiiiinnnnVVVVeeeerrrrttttiiiiccccaaaallllCCCChhhhaaaaiiiinnnn (((())))
      vvvviiiirrrrttttuuuuaaaallll QQQQCCCChhhhaaaaiiiinnnn**** mmmmaaaaiiiinnnnHHHHoooorrrriiiizzzzoooonnnnttttaaaallllCCCChhhhaaaaiiiinnnn (((())))
      vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd iiiinnnniiiittttGGGGMMMM (((())))

     DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
      The QBoxLayout class lines up    child widgets horizontally or
      vertically.

      QBoxLayout takes the space it    gets (from its parent layout
      or from the mainWindget()), divides it up into a row of
      boxes    and makes each managed widget fill one box.

      If the QBoxLayout is Horizontal, the boxes are beside    each
      other, with suitable sizes. Each widget (or other box) will
      get at least its minimum sizes and at    most its maximum size,
      and any excess space is shared according to the stretch
      factors (more    about that below).

      If the QBoxLayout is Vertical, the boxes are above and below
      each other, again with suitable sizes.

      The easiest way to create a QBoxLayout is to use one of the
      convenience classes QHBoxLayout (for Horizontal boxes) or
      QVBoxLayout (for Vertical boxes). You    can also use the
      QBoxLayout constuctor    directly, specifying its direction as
      LeftToRight, Down, RightToLeft or Up.



     Page 1                         (printed 9/22/98)






     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))



      If the QBoxLayout is not the top-level layout    (ie. is    not
      managing all of the widget's area and    children), you must
      add it to its    parent layout before you can do    anything with
      it. The normal way to    add a layout is    by calling
      parentLayout->addLayout().

      Once you have    done that, you can add boxes to    the QBoxLayout
      using    one of four functions:



     widget's stretch factor. (The stretch factor is along the row if
     boxes.)
      addWidget() to add a widget to the QBoxLayout    and set    the



     you use to    create nice and    spacious dialogs. See below for    ways
     to    set margins.
      addSpacing() to create an empty box; this is one of the functions



      addStretch() to create an empty, stretchable box.



     and set that layout's stretch factor.
      addLayout() to add a box containing another QLayout to the row



      Finally, if the layout is a top-level    one, you activate()
      it.

      QBoxLayout also includes two margin widths: The border width
      and the inter-box width. The border width is the width of
      the reserved space along each    of the QBoxLayout's four
      sides. The intra-widget width    is the width of    the
      automatically    allocated spacing between neighbouring boxes.
      (You can use addSpacing() to get more    space.)

      The border width defaults to 0, and the intra-widget width
      defaults to the same as the border width. Both are set using
      arguments to the constructor.

      You will almost always want to use the convenience classes
      for QBoxLayout: QVBoxLayout and QHBoxLayout, because of
      their    simpler    constructors.

      Examples:  pref/pref.cpp layout/layout.cpp




     Page 2                         (printed 9/22/98)






     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))



     MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDOOOOCCCCUUUUMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt (((( QQQQWWWWiiiiddddggggeeeetttt ****    ppppaaaarrrreeeennnntttt,,,,    DDDDiiiirrrreeeeccccttttiiiioooonnnn dddd,,,, iiiinnnntttt
      bbbboooorrrrddddeeeerrrr====0000,,,, iiiinnnntttt    aaaauuuuttttooooBBBBoooorrrrddddeeeerrrr ==== ----1111,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr **** nnnnaaaammmmeeee====0000 ))))
      Creates a new    QBoxLayout with    direction _d and    main widget
      _p_a_r_e_n_t. _p_a_r_e_n_t may not be 0.

      _b_o_r_d_e_r is the    number of pixels between the edge of the
      widget and the managed children. _a_u_t_o_B_o_r_d_e_r is the default
      number of pixels between neighbouring    children. If
      _a_u_t_o_B_o_r_d_e_r is    -1 the value of    _b_o_r_d_e_r is used.

      _n_a_m_e is the internal object name

      See also: direction().

      Examples:  layout/layout.cpp

     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt (((( DDDDiiiirrrreeeeccccttttiiiioooonnnn    dddd,,,, iiiinnnntttt aaaauuuuttttooooBBBBoooorrrrddddeeeerrrr ==== ----1111,,,,    ccccoooonnnnsssstttt
      cccchhhhaaaarrrr **** nnnnaaaammmmeeee====0000    ))))
      If _a_u_t_o_B_o_r_d_e_r    is -1, this QBoxLayout will inherit its
      parent's defaultBorder(), otherwise _a_u_t_o_B_o_r_d_e_r is used.

      You have to insert this box into another layout before using
      it.

     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::~~~~QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt (((())))
      Destroys this    box.

     vvvvooooiiiidddd QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::aaaaddddddddLLLLaaaayyyyoooouuuutttt    (((( QQQQLLLLaaaayyyyoooouuuutttt **** llllaaaayyyyoooouuuutttt,,,, iiiinnnntttt    ssssttttrrrreeeettttcccchhhh    ==== 0000 ))))
      Adds _l_a_y_o_u_t to the box, with serial stretch factor _s_t_r_e_t_c_h.

      See also: addWidget()    and addSpacing().

      Examples:  pref/pref.cpp layout/layout.cpp
      widgets/widgets.cpp

     vvvvooooiiiidddd QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::aaaaddddddddSSSSppppaaaacccciiiinnnngggg (((( iiiinnnntttt ssssiiiizzzzeeee ))))
      Adds a non-stretchable space with size _s_i_z_e. QBoxLayout
      gives    default    border and spacing. This function adds
      additional space.

      See also: addStretch().

      Examples:  widgets/widgets.cpp

     vvvvooooiiiidddd QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::aaaaddddddddSSSSttttrrrreeeettttcccchhhh (((( iiiinnnntttt ssssttttrrrreeeettttcccchhhh ==== 0000 ))))
      Adds a stretchable space with    zero minimum size and stretch
      factor _s_t_r_e_t_c_h.

      See also: addSpacing().

      Examples:  pref/pref.cpp widgets/widgets.cpp



     Page 3                         (printed 9/22/98)






     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))



     vvvvooooiiiidddd QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::aaaaddddddddSSSSttttrrrruuuutttt (((( iiiinnnntttt ssssiiiizzzzeeee ))))
      Limits the perpendicular dimension of    the box    (e.g. height
      if the box is    LeftToRight) to    a minimum of _s_i_z_e. Other
      constraints may increase the limit.

     vvvvooooiiiidddd QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::aaaaddddddddWWWWiiiiddddggggeeeetttt    (((( QQQQWWWWiiiiddddggggeeeetttt **** wwwwiiiiddddggggeeeetttt,,,, iiiinnnntttt    ssssttttrrrreeeettttcccchhhh    ==== 0000,,,,
      iiiinnnntttt aaaalllliiiiggggnnnn ==== AAAAlllliiiiggggnnnnCCCCeeeennnntttteeeerrrr ))))
      Adds _w_i_d_g_e_t to the box, with stretch factor _s_t_r_e_t_c_h and
      alignment _a_l_i_g_n.

      The stretch factor applies only in the direction of the
      QBoxLayout, and is relative to the other boxes and widgets
      in this QBoxLayout. Widgets and boxes    with higher stretch
      factor grow more.

      If the stretch factor    is 0 and nothing else in the
      QBoxLayout can grow at all, the widget may still grow    up to
      its maximum size.

      Alignment is perpendicular to    direction(), alignment in the
      serial direction is done with    addStretch().

      For horizontal boxes,    the possible alignments    are

      AlignCenter centers vertically in the    box.

      AlignTop aligns to the top border of the box.

      AlignBottom aligns to    the bottom border of the box.

      For vertical boxes, the possible alignments are

      AlignCenter centers horizontally in the box.

      AlignLeft aligns to the left border of the box.

      AlignRight aligns to the right border    of the box.

      Alignment only has effect if the size    of the box is greater
      than the widget's maximum size.

      See also: addLayout()    and addSpacing().

      Examples:  pref/pref.cpp layout/layout.cpp
      widgets/widgets.cpp

     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::DDDDiiiirrrreeeeccccttttiiiioooonnnn QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::ddddiiiirrrreeeeccccttttiiiioooonnnn(((()))) ccccoooonnnnsssstttt
      Returns the (serial) direction of the    box. addWidget(),
      addBox() and addSpacing() works in this direction; the
      stretch stretches in this direction. Alignment works
      perpendicular    to this    direction.




     Page 4                         (printed 9/22/98)






     QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))    QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt((((3333qqqqtttt))))



      The directions are LeftToRight, RightToLeft, TopToBottom and
      BottomToTop. For the last two, the shorter aliases Down and
      Up are also available.

      See also: addWidget(), addBox() and addSpacing().

     vvvvooooiiiidddd QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::iiiinnnniiiittttGGGGMMMM (((())))    [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
      Initializes this box.

      Reimplemented    from QLayout.

     QQQQCCCChhhhaaaaiiiinnnn **** QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::mmmmaaaaiiiinnnnHHHHoooorrrriiiizzzzoooonnnnttttaaaallllCCCChhhhaaaaiiiinnnn (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
      Returns the main horizontal chain, so    that a box can be put
      into other boxes (or other types of QLayout).

      Reimplemented    from QLayout.

     QQQQCCCChhhhaaaaiiiinnnn **** QQQQBBBBooooxxxxLLLLaaaayyyyoooouuuutttt::::::::mmmmaaaaiiiinnnnVVVVeeeerrrrttttiiiiccccaaaallllCCCChhhhaaaaiiiinnnn (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll    pppprrrrooootttteeeecccctttteeeedddd]]]]
      Returns the main vertical chain, so that a box can be    put
      into other boxes (or other types of QLayout).

      Reimplemented    from QLayout.

     SSSSEEEEEEEE AAAALLLLSSSSOOOO
      hhhhttttttttpppp::::////////wwwwwwwwwwww....ttttrrrroooollllllll....nnnnoooo////qqqqtttt////qqqqbbbbooooxxxxllllaaaayyyyoooouuuutttt....hhhhttttmmmmllll

     CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
      Copyright 1992-1997 Troll Tech AS.  See the LICENSE file
      included in the distribution for a complete license
      statement.

     AAAAUUUUTTTTHHHHOOOORRRR
      Generated automatically from the source code.






















     Page 5                         (printed 9/22/98)